TSC CloudConnect API 
 1.0.0 
OAS 3.1

/openapi.json

Devices

Get all current devices

Parameters

Name Description
x-api-key
string | (string | null)
(header)

Responses

Code Description Links
200

Successful Response

Media type
Controls Accept header. 
{
  "devices": {
    "agent_id_1": {
      "status": "online" | "offline",
      "subscribe": true,
      "model": "string"
    },
    "agent_id_2": {
      "status": "online" | "offline",
      "subscribe": true,
      "model": "string"
    },
    "agent_id_3": {
      "status": "online" | "offline",
      "subscribe": true,
      "model": "string"
    }
  }
}
 No links
422

Validation Error

Media type 
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
 No links

Parameters

Name Description
agent_id *
string
(path)
x-api-key
string | (string | null)
(header)

Request body 

{
  "data": "string",
  "type": "Base64" | "Hex",
  "pcl": null | "DPL" | "EPL" | "IER" | "IPL" | "MGL" | "PGL" | "SBPL" | "TEC" | "TSPL" | "ZPL"
}

{
  "data": ["string"],
  "type": "Text",
  "pcl": null | "DPL" | "EPL" | "IER" | "IPL" | "MGL" | "PGL" | "SBPL" | "TEC" | "TSPL" | "ZPL"
}

Responses

Code Description Links
200

Successful Response

Media type
Controls Accept header. 
{
  "message": "string",
  "tenant_id": "string",
  "topic": "string"
}
 No links
422

Validation Error

Media type 
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
 No links

Parameters

Name Description
agent_id *
string
(path)
x-api-key
string | (string | null)
(header)

Responses

Code Description Links
200

Successful Response

Media type
Controls Accept header. 
{
  "message": "string"
}
 No links
422

Validation Error

Media type 
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
 No links

Parameters

Name Description
agent_id *
string
(path)
x-api-key
string | (string | null)
(header)

Request body 

{
  "uri": "string",
  "save_filename": "string",
  "peer_cert_check": true
}

Responses

Code Description Links
200

Successful Response

Media type
Controls Accept header. 
{
  "message": "string",
  "tenant_id": "string",
  "topic": "string"
}
 No links
422

Validation Error

Media type 
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
 No links

Parameters

Name Description
agent_id *
string
(path)
x-api-key
string | (string | null)
(header)

Responses

Code Description Links
200

Successful Response

Media type
Controls Accept header. 
{
  "message": "string",
  "history": [
    {
      "id": "string",
      "type": "alert" | "status" | "request" | "response",
      "data": "string"
    }
  ]
}
 No links
422

Validation Error

Media type 
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
 No links